Qovery
API docs by Redocly

Qovery API (1.0.3)

Download OpenAPI specification:Download

Qovery Product Team: support+api+documentation@qovery.com URL: https://www.qovery.com
  • Qovery is the fastest way to deploy your full-stack apps on any Cloud provider.
  • ℹ️ The API is stable and still in development.

Organization Main Calls

List user organizations

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an organization

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string

name is case insensitive

description
string
plan
required
string (PlanEnum)
Enum: "FREE" "TEAM" "TEAM_YEARLY" "ENTERPRISE" "ENTERPRISE_YEARLY"
website_url
string or null
repository
string or null
logo_url
string or null
icon_url
string or null
admin_emails
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "plan": "FREE",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "plan": "FREE",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Get organization by ID

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "plan": "FREE",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Edit an organization

To edit an organization you must have the admin permission

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string
website_url
string or null
repository
string or null
logo_url
string or null
icon_url
string or null
admin_emails
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "plan": "FREE",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Delete an organization

To delete an organization you must have the admin permission

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

List organization available roles

List organization available roles

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Organization Api Token

List organization api tokens

List organization api tokens

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an organization api token

Create an organization api token. You can use the generated token to interact in a programmatic way with our API.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
description
string
scope
required
string (OrganizationApiTokenScope)
Value: "ADMIN"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "scope": "ADMIN"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "token": "string",
  • "scope": "ADMIN"
}

Delete organization api token

Delete organization api token

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

apiTokenId
required
string <uuid>

Organization Api Token ID

Responses

Organization Account Git Repositories

Get git provider accounts

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{}

Get github branches of the specified repository

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

query Parameters
name
string

The name of the repository to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Organization Webhook

List organization webhooks

List organization webhooks

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an organization webhook

Create an organization webhook.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
kind
required
string (OrganizationWebhookKindEnum)
Enum: "STANDARD" "SLACK"

Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The target_url must be a Slack compatible endpoint.

target_url
required
string

Set the public HTTP or HTTPS endpoint that will receive the specified events. The target URL must starts with http:// or https://

target_secret
string

Make sure you receive a payload to sign the Qovery request with your secret. Qovery will add a HTTP header Qovery-Signature: <Your Secret> to every webhook requests sent to your target URL.

description
string
enabled
boolean

Turn on or off your endpoint.

events
required
Array of strings (OrganizationWebhookEventEnum)
Items Enum: "DEPLOYMENT_STARTED" "DEPLOYMENT_CANCELLED" "DEPLOYMENT_FAILURE" "DEPLOYMENT_SUCCESSFUL"
project_names_filter
Array of strings

Specify the project names you want to filter to. This webhook will be triggered only if the event is coming from the specified Project IDs. Notes: 1. Wildcard is accepted E.g. product*. 2. Name is case insensitive.

environment_types_filter
Array of strings (EnvironmentModeEnum)
Items Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING"

Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode.

Responses

Request samples

Content type
application/json
{
  • "kind": "STANDARD",
  • "target_url": "string",
  • "target_secret": "string",
  • "description": "string",
  • "enabled": true,
  • "events": [
    ],
  • "project_names_filter": [
    ],
  • "environment_types_filter": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "kind": "STANDARD",
  • "target_url": "string",
  • "target_secret_set": true,
  • "description": "string",
  • "enabled": true,
  • "events": [
    ],
  • "project_names_filter": [
    ],
  • "environment_types_filter": [
    ]
}

Get an Organization webhook

Get an Organization webhook

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

webhookId
required
string <uuid>

Webhook ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "kind": "STANDARD",
  • "target_url": "string",
  • "target_secret_set": true,
  • "description": "string",
  • "enabled": true,
  • "events": [
    ],
  • "project_names_filter": [
    ],
  • "environment_types_filter": [
    ]
}

Edit an organization webhook

Edit an organization webhook

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

webhookId
required
string <uuid>

Webhook ID

Request Body schema: application/json
kind
required
string (OrganizationWebhookKindEnum)
Enum: "STANDARD" "SLACK"

Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The target_url must be a Slack compatible endpoint.

target_url
required
string

Set the public HTTP or HTTPS endpoint that will receive the specified events. The target URL must starts with http:// or https://

target_secret
string

Make sure you receive a payload to sign the Qovery request with your secret. Qovery will add a HTTP header Qovery-Signature: <Your Secret> to every webhook requests sent to your target URL.

description
string
enabled
boolean

Turn on or off your endpoint.

events
required
Array of strings (OrganizationWebhookEventEnum)
Items Enum: "DEPLOYMENT_STARTED" "DEPLOYMENT_CANCELLED" "DEPLOYMENT_FAILURE" "DEPLOYMENT_SUCCESSFUL"
project_names_filter
Array of strings

Specify the project names you want to filter to. This webhook will be triggered only if the event is coming from the specified Project IDs. Notes: 1. Wildcard is accepted E.g. product*. 2. Name is case insensitive.

environment_types_filter
Array of strings (EnvironmentModeEnum)
Items Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING"

Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode.

Responses

Request samples

Content type
application/json
{
  • "kind": "STANDARD",
  • "target_url": "string",
  • "target_secret": "string",
  • "description": "string",
  • "enabled": true,
  • "events": [
    ],
  • "project_names_filter": [
    ],
  • "environment_types_filter": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "kind": "STANDARD",
  • "target_url": "string",
  • "target_secret_set": true,
  • "description": "string",
  • "enabled": true,
  • "events": [
    ],
  • "project_names_filter": [
    ],
  • "environment_types_filter": [
    ]
}

Delete organization webhook

Delete organization webhook

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

webhookId
required
string <uuid>

Webhook ID

Responses

Organization Custom Role

List organization custom roles

List organization custom roles

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an organization custom role

Create an organization custom role

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "cluster_permissions": [
    ],
  • "project_permissions": [
    ]
}

Get an organization custom role

Get an organization custom role

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

customRoleId
required
string <uuid>

Custom Role ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "cluster_permissions": [
    ],
  • "project_permissions": [
    ]
}

Edit an organization custom role

Edit an organization custom role

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

customRoleId
required
string <uuid>

Custom Role ID

Request Body schema: application/json
name
required
string
description
string
required
Array of objects

Should contain an entry for every existing cluster

required
Array of objects

Should contain an entry for every existing project

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cluster_permissions": [
    ],
  • "project_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "cluster_permissions": [
    ],
  • "project_permissions": [
    ]
}

Delete organization custom role

Delete organization custom role

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

customRoleId
required
string <uuid>

Custom Role ID

Responses

Projects

List projects

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a project

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "organization": {
    }
}

List total number of services and environments for each project of the organization

Returns a list of project ids, and for each its total numberof services and environments

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Members

Get organization members

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Edit an organization member role

Edit an organization member role

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
user_id
required
string

specify the git provider user id

role_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}

Remove a member

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
user_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Get invited members

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Invite someone in the organization

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
email
required
string
role
string (InviteMemberRoleEnum)
Enum: "ADMIN" "DEVELOPER" "OWNER" "VIEWER"

deprecated

role_id
string <uuid>

the target role to attribute to the new member

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "role": "ADMIN",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "role": "ADMIN",
  • "invitation_link": "http://example.com",
  • "invitation_status": "EXPIRED",
  • "inviter": "string",
  • "logo_url": "http://example.com",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "role_name": "string"
}

Accept Invite in the organization

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

inviteId
required
string <uuid>

Invite ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "role": "ADMIN",
  • "invitation_link": "http://example.com",
  • "invitation_status": "EXPIRED",
  • "inviter": "string",
  • "logo_url": "http://example.com",
  • "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  • "role_name": "string"
}

Remove an invited member

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

inviteId
required
string <uuid>

Invite ID

Responses

Transfer organization ownership to another user

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
user_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Billing

Get organization current cost

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "plan": "FREE",
  • "remaining_trial_day": 0,
  • "remaining_credits": {
    },
  • "cost": {
    },
  • "paid_usage": {
    }
}

Add credit code

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Change organization plan

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
plan
string

Responses

Request samples

Content type
application/json
{
  • "plan": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "plan": "FREE",
  • "website_url": "string",
  • "repository": "string",
  • "logo_url": "string",
  • "icon_url": "string",
  • "admin_emails": [
    ],
  • "owner": "534359f7-5407-4b19-ba92-c71c370022a5"
}

Get cluster current cost

Get your cluster cost range. We are unable to give a precise cost of your infrastructure at the moment. But Qovery guarantees that the cost of your cluster will not exceed the max range.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "min_cost_in_cents": 15000,
  • "min_cost": 150,
  • "max_cost_in_cents": 30000,
  • "max_cost": 300,
  • "currency_code": "USD"
}

Get organization billing info

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "first_name": "Forrest",
  • "last_name": "Gump",
  • "email": "forrest@gump.com",
  • "address": "21 Jenny Street",
  • "city": "Greenbow",
  • "zip": "36744",
  • "state": "Alabama",
  • "country_code": "US",
  • "company": "string",
  • "vat_number": "string"
}

Edit Organization Billing Info

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
first_name
required
string
last_name
required
string
email
required
string <email>

email used for billing, and to receive all invoices by email

address
required
string
city
required
string
zip
required
string
state
string

only for US

country_code
required
string

ISO code of the country

company
string

name of the company to bill

vat_number
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "Forrest",
  • "last_name": "Gump",
  • "email": "forrest@gump.com",
  • "address": "21 Jenny Street",
  • "city": "Greenbow",
  • "zip": "36744",
  • "state": "Alabama",
  • "country_code": "US",
  • "company": "string",
  • "vat_number": "string"
}

Response samples

Content type
application/json
{
  • "first_name": "Forrest",
  • "last_name": "Gump",
  • "email": "forrest@gump.com",
  • "address": "21 Jenny Street",
  • "city": "Greenbow",
  • "zip": "36744",
  • "state": "Alabama",
  • "country_code": "US",
  • "company": "string",
  • "vat_number": "string"
}

Get organization billing status

This endpoint returns a "is_valid" boolean field reflecting the billing status of the organization:

  • If true, the organization billing is valid
  • For Startup organization, it returns false if there is at least 1 invoice unpaid since 1 week
  • For Community organization, it returns false if there is no credit left
Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "is_valid": true,
  • "message": "string"
}

List organization invoices

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get organization invoice

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

invoiceId
required
string <uuid>

Invoice ID

Responses

Response samples

Content type
application/json
{
  • "total_in_cents": 30000,
  • "total": 300,
  • "currency_code": "USD",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "NOT_PAID"
}

Get invoice link

This will return URL of the invoice PDF

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

invoiceId
required
string <uuid>

Invoice ID

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Download all invoices

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

List organization credit cards

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add credit card

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
number
required
string
cvv
required
string
expiry_month
required
integer
expiry_year
required
integer

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "cvv": "string",
  • "expiry_month": 6,
  • "expiry_year": 2025
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expiry_month": 6,
  • "expiry_year": 2025,
  • "last_digit": "7890",
  • "is_expired": true
}

Delete credit card

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

creditCardId
required
string <uuid>

Credit Card ID

Responses

Clusters

List organization clusters

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a cluster

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string

name is case-insensitive

description
string
region
required
string
cloud_provider
required
string (CloudProviderEnum)
Enum: "AWS" "DO" "SCW"
min_running_nodes
integer
Default: 1
max_running_nodes
integer
Default: 1
disk_size
integer
Default: 20

Unit is in GB. The disk size to be used for the node configuration

instance_type
string

the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType

kubernetes
string (KubernetesEnum)
Enum: "K3S" "MANAGED"
production
boolean

specific flag to indicate that this cluster is a production one

ssh_keys
Array of strings

Indicate your public ssh_key to remotely connect to your EC2 instance.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

List all clusters statuses

Returns a list of clusters with only their id and status.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Delete a cluster

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Edit a cluster

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Request Body schema: application/json
name
required
string

name is case-insensitive

description
string
region
required
string
cloud_provider
required
string (CloudProviderEnum)
Enum: "AWS" "DO" "SCW"
min_running_nodes
integer
Default: 1
max_running_nodes
integer
Default: 1
disk_size
integer
Default: 20

Unit is in GB. The disk size to be used for the node configuration

instance_type
string

the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType

kubernetes
string (KubernetesEnum)
Enum: "K3S" "MANAGED"
production
boolean

specific flag to indicate that this cluster is a production one

ssh_keys
Array of strings

Indicate your public ssh_key to remotely connect to your EC2 instance.

Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "region": "string",
  • "cloud_provider": "AWS",
  • "min_running_nodes": 1,
  • "max_running_nodes": 1,
  • "disk_size": 50,
  • "instance_type": "T3A_LARGE",
  • "kubernetes": "K3S",
  • "cpu": 10000,
  • "memory": 4096,
  • "estimated_cloud_provider_cost": 0,
  • "status": "BUILDING",
  • "has_access": true,
  • "version": "string",
  • "is_default": true,
  • "production": true,
  • "ssh_keys": [
    ],
  • "features": [
    ]
}

Get cluster status

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "status": "BUILDING",
  • "is_deployed": true,
  • "last_execution_id": "f73e3833-922a-48a5-9dbd-6163f43f9143-1656410242"
}

Get advanced settings

Get list and values of the advanced settings of the cluster.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "registry.image_retention_time": 31536000,
  • "load_balancer.size": "lb-s",
  • "pleco.resources_ttl": -1,
  • "loki.log_retention_in_week": 12
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Request Body schema: application/json
registry.image_retention_time
integer
Default: 31536000

Configure the number of seconds before cleaning images in the registry

load_balancer.size
string
Default: "lb-s"

Select the size of the main load_balancer (only effective for Scaleway)

pleco.resources_ttl
integer
Deprecated
Default: -1
loki.log_retention_in_week
integer
Default: 12

For how long in week loki is going to keep logs of your applications

Responses

Request samples

Content type
application/json
{
  • "registry.image_retention_time": 31536000,
  • "load_balancer.size": "lb-s",
  • "pleco.resources_ttl": -1,
  • "loki.log_retention_in_week": 12
}

Response samples

Content type
application/json
{
  • "registry.image_retention_time": 31536000,
  • "load_balancer.size": "lb-s",
  • "pleco.resources_ttl": -1,
  • "loki.log_retention_in_week": 12
}

Get routing table

Retrieve network routing table where each line corresponds to a route between a destination and a target.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Edit routing table

Edit routing table by returning updated table.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "routes": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Cluster Logs

List Cluster Logs

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get cluster cloud provider info and credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "cloud_provider": "AWS",
  • "credentials": {
    },
  • "region": "string"
}

Specify cluster cloud provider info and credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Request Body schema: application/json
cloud_provider
string (CloudProviderEnum)
Enum: "AWS" "DO" "SCW"
object
region
string

Responses

Request samples

Content type
application/json
{
  • "cloud_provider": "AWS",
  • "credentials": {
    },
  • "region": "string"
}

Response samples

Content type
application/json
{
  • "cloud_provider": "AWS",
  • "credentials": {
    },
  • "region": "string"
}

Know if a cluster is ready to be deployed or not

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "is_ready": true
}

Deploy a cluster

allows to deploy a cluster

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "status": "BUILDING",
  • "is_deployed": true
}

Update a cluster Version

allows to update cluster version

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "status": "BUILDING",
  • "is_deployed": true
}

Stop cluster

Cluster stop has been requester.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

clusterId
required
string <uuid>

Cluster ID

Responses

Response samples

Content type
application/json
{
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "status": "BUILDING",
  • "is_deployed": true
}

Cloud Provider

List Cloud providers available

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List AWS regions

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List AWS features available

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List AWS available instance types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List AWS EC2 available instance types

Authorizations:
bearerAuth
path Parameters
region
required
string
Example: us-east-2

region name

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List AWS EKS available instance types

Authorizations:
bearerAuth
path Parameters
region
required
string
Example: us-east-2

region name

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List DO regions

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List DO features available

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List DO available instance types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Scaleway regions

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Scaleway features available

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Scaleway available instance types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List Scaleway Kapsule available instance types

Authorizations:
bearerAuth
path Parameters
zone
required
string
Example: fr-par-1

zone name

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Cloud Provider Credentials

List AWS credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create AWS credentials set

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
access_key_id
required
string
secret_access_key
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Get a set of AWS credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Edit a set of AWS credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Request Body schema: application/json
name
required
string
access_key_id
required
string
secret_access_key
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete a set of AWS credentials

Authorizations:
bearerAuth
path Parameters
credentialsId
required
string <uuid>

Credentials ID

organizationId
required
string <uuid>

Organization ID

Responses

List DO credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create Digital Ocean credentials set

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
token
string
spaces_access_id
string
spaces_secret_key
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "spaces_access_id": "string",
  • "spaces_secret_key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Get a set of Digital Ocean credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Edit a set of Digital Ocean credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Request Body schema: application/json
name
required
string
token
string
spaces_access_id
string
spaces_secret_key
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "token": "string",
  • "spaces_access_id": "string",
  • "spaces_secret_key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete a set of Digital Ocean credentials

Authorizations:
bearerAuth
path Parameters
credentialsId
required
string <uuid>

Credentials ID

organizationId
required
string <uuid>

Organization ID

Responses

List Scaleway credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create Scaleway credentials set

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
scaleway_access_key
string
scaleway_secret_key
string
scaleway_project_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scaleway_access_key": "string",
  • "scaleway_secret_key": "string",
  • "scaleway_project_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Get a set of Scaleway credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Edit a set of Scaleway credentials

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

credentialsId
required
string <uuid>

Credentials ID

Request Body schema: application/json
name
required
string
scaleway_access_key
string
scaleway_secret_key
string
scaleway_project_id
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scaleway_access_key": "string",
  • "scaleway_secret_key": "string",
  • "scaleway_project_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Delete a set of Scaleway credentials

Authorizations:
bearerAuth
path Parameters
credentialsId
required
string <uuid>

Credentials ID

organizationId
required
string <uuid>

Organization ID

Responses

Github App

Connect a github account to an organization

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
installation_id
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "installation_id": "string",
  • "code": "string"
}

Disconnect a github account from an organization

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

query Parameters
force
boolean

Indicates if the github app should be disconnected despite github applications linked to organization

Responses

Container Registries

List organization container registries

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a container registry

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
name
required
string
kind
required
string (ContainerRegistryKindEnum)
Enum: "ECR" "SCALEWAY_CR" "DOCKER_HUB" "PUBLIC_ECR" "DOCR"

The type of your container registry

description
string
url
string <uri>

URL of the container registry:

  • For DOCKER_HUB: it must be https://docker.io (default with 'https://docker.io' if no url provided for DOCKER_HUB)
  • For others: it's required and must start by https://
required
object

This field is dependent of the container registry kind:

  • ECR needs in the config: region, access_key_id, secret_access_key
  • SCALEWAY_CR needs in the config: region, scaleway_access_key, scaleway_secret_key
  • DOCKER_HUB needs in the config (optional): username, password
  • PUBLIC_ECR doesn't need credentials info
  • DOCR is not supported anymore

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "ECR",
  • "description": "string",
  • "url": "http://example.com",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind": "ECR",
  • "description": "string",
  • "url": "string",
  • "cluster": {
    }
}

Get a container registry

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind": "ECR",
  • "description": "string",
  • "url": "string",
  • "cluster": {
    }
}

Delete a container registry

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Responses

Edit a container registry

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Request Body schema: application/json
name
required
string
kind
required
string (ContainerRegistryKindEnum)
Enum: "ECR" "SCALEWAY_CR" "DOCKER_HUB" "PUBLIC_ECR" "DOCR"

The type of your container registry

description
string
url
string <uri>

URL of the container registry:

  • For DOCKER_HUB: it must be https://docker.io (default with 'https://docker.io' if no url provided for DOCKER_HUB)
  • For others: it's required and must start by https://
required
object

This field is dependent of the container registry kind:

  • ECR needs in the config: region, access_key_id, secret_access_key
  • SCALEWAY_CR needs in the config: region, scaleway_access_key, scaleway_secret_key
  • DOCKER_HUB needs in the config (optional): username, password
  • PUBLIC_ECR doesn't need credentials info
  • DOCR is not supported anymore

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "ECR",
  • "description": "string",
  • "url": "http://example.com",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "kind": "ECR",
  • "description": "string",
  • "url": "string",
  • "cluster": {
    }
}

List supported container registries

List supported container registries by Qovery and get the mandatory authentification configuration.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Project Main Calls

Get project by ID

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "organization": {
    }
}

Edit a project

To edit a project you must have the admin permission

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "organization": {
    }
}

Delete a project

To delete a project you must have the admin permission

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Environments

List environments

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an environment

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
name
required
string

name is case insensitive

cluster
string <uuid>
mode
string (CreateEnvironmentModeEnum)
Enum: "DEVELOPMENT" "PRODUCTION" "STAGING"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cluster": "75f2c581-ef2d-4437-9fa8-a27342452fc4",
  • "mode": "PRODUCTION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "project": {
    },
  • "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
  • "cloud_provider": {
    },
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "cluster_name": "string"
}

List environments statuses

Returns a list of environments with only their id and status.

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List total number of services for each environment of the project

Returns a list of environment ids, and for each its total numberof services

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Project Deployment Rule

List project deployment rules

List project deployment rules

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a deployment rule

Create a deployment rule

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string or null
mode
required
string (EnvironmentModeEnum)
Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING"
cluster_id
required
string <uuid>
auto_deploy
boolean
Default: false
auto_stop
boolean
Default: false
auto_delete
boolean
Default: false
timezone
required
string
start_time
required
string <date-time>
stop_time
required
string <date-time>
weekdays
required
Array of strings (WeekdayEnum)
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"
wildcard
required
string
Default: ""

wildcard pattern composed of '?' and/or '*' used to target new created environments

Responses

Request samples

Content type
application/json
{
  • "name": "project-rule",
  • "description": "description project rule",
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "auto_deploy": false,
  • "auto_stop": false,
  • "auto_delete": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ],
  • "wildcard": ""
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "project-rule",
  • "description": "description project rule",
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "auto_deploy": false,
  • "auto_stop": false,
  • "auto_delete": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ],
  • "wildcard": "",
  • "priority_index": 0
}

Get a project deployment rule

Get a project deployment rule

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

deploymentRuleId
required
string <uuid>

Deployment Rule ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "project-rule",
  • "description": "description project rule",
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "auto_deploy": false,
  • "auto_stop": false,
  • "auto_delete": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ],
  • "wildcard": "",
  • "priority_index": 0
}

Edit a project deployment rule

Edit a project deployment rule

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

deploymentRuleId
required
string <uuid>

Deployment Rule ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string or null
mode
required
string (EnvironmentModeEnum)
Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING"
cluster_id
required
string <uuid>
auto_deploy
boolean
Default: false
auto_stop
boolean
Default: false
auto_delete
boolean
Default: false
timezone
required
string
start_time
required
string <date-time>
stop_time
required
string <date-time>
weekdays
required
Array of strings (WeekdayEnum)
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"
wildcard
required
string
Default: ""

wildcard pattern composed of '?' and/or '*' used to target new created environments

Responses

Request samples

Content type
application/json
{
  • "name": "project-rule",
  • "description": "description project rule",
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "auto_deploy": false,
  • "auto_stop": false,
  • "auto_delete": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ],
  • "wildcard": ""
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "project-rule",
  • "description": "description project rule",
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "auto_deploy": false,
  • "auto_stop": false,
  • "auto_delete": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ],
  • "wildcard": "",
  • "priority_index": 0
}

Delete a project deployment rule

Delete a project deployment rule

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

deploymentRuleId
required
string <uuid>

Deployment Rule ID

Responses

Update deployment rules priority order

Update deployment rules priority order

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
project_deployment_rule_ids_in_order
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "project_deployment_rule_ids_in_order": [
    ]
}

Project Environment Variable

List project environment variables

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the project

  • Add an environment variable to the project.
    • If the environment variable key already exists, then it will be replaced by the new one.
    • If the environment variable value points toward an existing environment variable key, it will be considered as an alias.
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete an environment variable from a project

  • To delete an environment variable you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Responses

Edit an environment variable belonging to the project

  • You can't edit a BUILT_IN variable
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable override at the project level

  • Allows you to override at project level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at project level with the same key as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the overridden_variable will be exposed in the "overridden_variable" field of the newly created variable
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable alias at the project level

  • Allows you to add an alias at project level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at project level with the same value as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Project Secret

List project secrets

Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the project

  • Add a secret to the project.
    • If the secret key already exists, then it will be replaced by the new one.
    • If the secret value points toward an existing secret key, it will be considered as an alias.
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the secret. Clear value will never be returned

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete a secret from a project

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well operationId: deleteProjectSecret
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

secretId
required
string <uuid>

Secret ID

Responses

Edit a secret belonging to the project

  • You can't edit a BUILT_IN secret
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string
key
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret override at the project level

  • Allows you to override at project level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at project level with the same key as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the overridden_secret will be exposed in the "overridden_secret" field of the newly created secret
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret alias at the project level

  • Allows you to add an alias at project level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at project level with the same value as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
projectId
required
string <uuid>

Project ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Environment Main Calls

Get environment by ID

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "project": {
    },
  • "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
  • "cloud_provider": {
    },
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "cluster_name": "string"
}

Edit an environment

To edit an environment you must have the admin permission

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
name
string
mode
string (CreateEnvironmentModeEnum)
Enum: "DEVELOPMENT" "PRODUCTION" "STAGING"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "mode": "PRODUCTION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "project": {
    },
  • "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
  • "cloud_provider": {
    },
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "cluster_name": "string"
}

Delete an environment

To delete an environment you must have the admin permission

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Get environment status

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Applications

List applications

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

query Parameters
toUpdate
boolean
Default: false

return (or not) results that must be updated

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an application

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

description
string or null

give a description to this application

required
object (ApplicationGitRepositoryRequest)
build_mode
string (BuildModeEnum)
Default: "BUILDPACKS"
Enum: "BUILDPACKS" "DOCKER"

DOCKER requires dockerfile_path BUILDPACKS does not require any dockerfile_path

dockerfile_path
string or null

The path of the associated Dockerfile. Only if you are using build_mode = DOCKER

buildpack_language
string or null (BuildPackLanguageEnum)
Enum: "CLOJURE" "GO" "GRADLE" "GRAILS" "JAVA" "JVM" "NODE_JS" "PHP" "PLAY" "PYTHON" "SCALA"

Development language of the application

cpu
integer
Default: 500

unit is millicores (m). 1000m = 1 cpu

memory
integer
Default: 512

unit is MB. 1024 MB = 1GB

min_running_instances
integer >= 0
Default: 1

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running.

max_running_instances
integer
Default: 1

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

object (Healthcheck)
auto_preview
boolean
Default: true

Specify if the environment preview option is activated or not for this application.
If activated, a preview environment will be automatically cloned at each pull request.
If not specified, it takes the value of the auto_preview property from the associated environment.

Responses

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

List all environment applications statuses

Returns a list of applications with only their id and status.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage for each application

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current scaling information for each application

Returns min, max, and running number of instances for each application

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List supported languages

Returns list of languages supported by Buildpacks.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List default application advanced settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "deployment.delay_start_time_sec": 30,
  • "deployment.custom_domain_check_enabled": true,
  • "build.timeout_max_sec": 1800,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "readiness_probe.type": "NONE",
  • "readiness_probe.http_get.path": "/",
  • "readiness_probe.initial_delay_seconds": 30,
  • "readiness_probe.period_seconds": 10,
  • "readiness_probe.timeout_seconds": 1,
  • "readiness_probe.success_threshold": 1,
  • "readiness_probe.failure_threshold": 3,
  • "liveness_probe.type": "NONE",
  • "liveness_probe.http_get.path": "/",
  • "liveness_probe.initial_delay_seconds": 30,
  • "liveness_probe.period_seconds": 10,
  • "liveness_probe.timeout_seconds": 5,
  • "liveness_probe.success_threshold": 1,
  • "liveness_probe.failure_threshold": 3,
  • "hpa.cpu.average_utilization_percent": 60
}

Containers

List all container registry container statuses

Returns a list of containers with only their id and status.

Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List containers

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

query Parameters
toUpdate
boolean
Default: false

return (or not) results that must be updated

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a container

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

registry_id
required
string

id of the linked registry

image_name
required
string

The image name pattern differs according to chosen container registry provider:

  • ECR: repository
  • SCALEWAY_CR: namespace/image
  • DOCKER_HUB: image or repository/image
  • PUBLIC_ECR: registry_alias/repository
tag
required
string

tag of the image container

arguments
Array of strings
entrypoint
string

optional entrypoint when launching container

cpu
integer
Default: 500

unit is millicores (m). 1000m = 1 cpu

memory
integer
Default: 512

unit is MB. 1024 MB = 1GB

min_running_instances
integer >= 0
Default: 1

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.

max_running_instances
integer
Default: 1

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_preview
boolean

Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

Responses

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "registry_id": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true,
  • "ports": [
    ]
}

List all environment container statuses

Returns a list of containers with only their id and status.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage for each containers

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current scaling information for each container

Returns min, max, and running number of instances for each container

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Deploy services

Update and deploy the selected services

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "applications": [
    ],
  • "containers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Auto deploy containers

Triggers a new container deploy in each environment matching the following conditions

  • environment should have the auto-deploy enabled
  • the container should have the same image name and a different tag
Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
image_name
string

the container image name to deploy

tag
string

the new tag to deploy

Responses

Request samples

Content type
application/json
{
  • "image_name": "string",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Preview container environments

Triggers a new container preview for each environment matching the following conditions

  • preview environment feature should be enabled for the container
  • the container should have the same image name and a different tag
Authorizations:
bearerAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

Request Body schema: application/json
image_name
string

the container image name to trigger preview environment

tag
string

the tag to be used in the preview environment

Responses

Request samples

Content type
application/json
{
  • "image_name": "string",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Databases

List eligible database types, versions and modes for the environment

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List environment databases

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a database

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
name
required
string

name is case insensitive

type
required
string (DatabaseTypeEnum)
Enum: "MONGODB" "MYSQL" "POSTGRESQL" "REDIS"
version
required
string
mode
required
string (DatabaseModeEnum)
Enum: "CONTAINER" "MANAGED"
accessibility
string (DatabaseAccessibilityEnum)
Default: "PRIVATE"
Enum: "PRIVATE" "PUBLIC"
cpu
integer
Default: 250

unit is millicores (m). 1000m = 1 cpu

memory
integer

unit is MB. 1024 MB = 1GB
Default value is linked to the database type:

  • MANAGED: 100
  • CONTAINER
    • POSTGRES: 100
    • REDIS: 100
    • MYSQL: 512
    • MONGODB: 256
storage
integer
Default: 10

unit is GB

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 10
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

List all environment databases statuses

Returns a list of databases with only their id and status.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current metric consumption for each database

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Environment Actions

Deploy environment

This will deploy all the services of this environment to their latest version.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Stop environment

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Restart environment

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
restart_db
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "restart_db": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Cancel environment deployment

Cancel the current deployment of your environment.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Clone environment

You must provide a name. This will create a new environment, with the same configuration, and same applications and databases. Database data is not cloned.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
name
required
string

name is case insensitive

cluster_id
string <uuid>
mode
string (EnvironmentModeEnum)
Enum: "DEVELOPMENT" "PREVIEW" "PRODUCTION" "STAGING"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "mode": "PRODUCTION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "project": {
    },
  • "last_updated_by": "e51d5fee-238a-41fd-a36d-38209c61fb21",
  • "cloud_provider": {
    },
  • "mode": "PRODUCTION",
  • "cluster_id": "d3d1bfdf-67c4-41fa-b065-858242731616",
  • "cluster_name": "string"
}

Environment Logs

List environment deployment logs

This returns the last 1000 environment deployment logs.

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Environment Deployment History

List environment deployments

List previous and current environment deployments with the status deployment and the related services. By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Environment Deployment Rule

Get environment deployment rule

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "auto_deploy": true,
  • "auto_stop": false,
  • "auto_delete": false,
  • "auto_preview": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ]
}

Edit an environment deployment rule

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

deploymentRuleId
required
string <uuid>

Deployment Rule ID

Request Body schema: application/json
auto_deploy
boolean
Default: true
auto_delete
boolean
Default: false
auto_stop
boolean
Default: false
timezone
required
string
start_time
required
string <date-time>
stop_time
required
string <date-time>
weekdays
required
Array of strings (WeekdayEnum)
Items Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" "SATURDAY" "SUNDAY"

Responses

Request samples

Content type
application/json
{
  • "auto_deploy": true,
  • "auto_delete": false,
  • "auto_stop": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "auto_deploy": true,
  • "auto_stop": false,
  • "auto_delete": false,
  • "auto_preview": false,
  • "timezone": "UTC",
  • "start_time": "1970-01-01T08:00:00.000Z",
  • "stop_time": "1970-01-01T19:00:00.000Z",
  • "weekdays": [
    ]
}

Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the environment

  • Add an environment variable to the environment.
    • If the environment variable key already exists, then it will be replaced by the new one.
    • If the environment variable value points toward an existing environment variable key, it will be considered as an alias.
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete an environment variable from an environment

  • To delete an environment variable you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Responses

Edit an environment variable belonging to the environment

  • You can't edit a BUILT_IN variable
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable override at the environment level

  • Allows you to override at environment level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at environment level with the same key as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the overridden_variable will be exposed in the "overridden_variable" field of the newly created variable
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable alias at the environment level

  • Allows you to add an alias at environment level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at environment level with the same value as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Environment Secret

List environment secrets

Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the environment

  • Add a secret to the environment.
    • If the secret key already exists, then it will be replaced by the new one.
    • If the secret value points toward an existing secret key, it will be considered as an alias.
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the secret. Clear value will never be returned

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete a secret from the environment

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well operationId: deleteEnvironmentSecret
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

secretId
required
string <uuid>

Secret ID

Responses

Edit a secret belonging to the environment

  • You can't edit a BUILT_IN secret
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string
key
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret override at the environment level

  • Allows you to override at environment level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at environment level with the same key as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the overridden_secret will be exposed in the "overridden_secret" field of the newly created secret
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret alias at the environment level

  • Allows you to add an alias at environment level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at environment level with the same value as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Application Main Calls

Get application by ID

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Edit application

  • To edit the application you must have the admin permission.
  • For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it.
  • For storage edition, if you provide a storage id, we will update the corresponding storage. If you don't we will create a new one. If you remove a storage from the payload, we will delete it.
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
Array of objects
name
string

name is case insensitive

description
string

give a description to this application

object (ApplicationGitRepositoryRequest)
build_mode
string (BuildModeEnum)
Default: "BUILDPACKS"
Enum: "BUILDPACKS" "DOCKER"

DOCKER requires dockerfile_path BUILDPACKS does not require any dockerfile_path

dockerfile_path
string

The path of the associated Dockerfile

buildpack_language
string or null (BuildPackLanguageEnum)
Enum: "CLOJURE" "GO" "GRADLE" "GRAILS" "JAVA" "JVM" "NODE_JS" "PHP" "PLAY" "PYTHON" "SCALA"

Development language of the application

cpu
integer
Default: 500

unit is millicores (m). 1000m = 1 cpu

memory
integer
Default: 512

unit is MB. 1024 MB = 1GB

min_running_instances
integer >= 0
Default: 1

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no application running.

max_running_instances
integer
Default: 1

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

object (Healthcheck)
auto_preview
boolean
Default: true

Specify if the environment preview option is activated or not for this application.
If activated, a preview environment will be automatically cloned at each pull request.
If not specified, it takes the value of the auto_preview property from the associated environment.

sticky_session
boolean
Default: false

Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application.

Array of objects (ServicePortResponseList)

Responses

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true,
  • "sticky_session": false,
  • "ports": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Delete application

To delete the application you must have the admin permission

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Get application status

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

List contributors

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List tags

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add application tag

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Delete application tag

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

tagId
required
string <uuid>

Tag ID

Responses

List last commits

Returns list of the last 100 commits made on the repository linked to the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
startId
string <uuid>

Starting point after which to return results

gitCommitId
string <uuid>

Git Commit ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Actions

Deploy application

You must provide a git commit id

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
git_commit_id
required
string

Commit ID to deploy

Responses

Request samples

Content type
application/json
{
  • "git_commit_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Stop application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Restart application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Application Configuration

Get Application Network information

Get status of the application network settings.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Application Network

Edit the Network settings of the application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
sticky_session
boolean
Default: false

Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application.

Responses

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Get advanced settings

Get list and values of the advanced settings of the application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "deployment.delay_start_time_sec": 30,
  • "deployment.custom_domain_check_enabled": true,
  • "build.timeout_max_sec": 1800,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "readiness_probe.type": "NONE",
  • "readiness_probe.http_get.path": "/",
  • "readiness_probe.initial_delay_seconds": 30,
  • "readiness_probe.period_seconds": 10,
  • "readiness_probe.timeout_seconds": 1,
  • "readiness_probe.success_threshold": 1,
  • "readiness_probe.failure_threshold": 3,
  • "liveness_probe.type": "NONE",
  • "liveness_probe.http_get.path": "/",
  • "liveness_probe.initial_delay_seconds": 30,
  • "liveness_probe.period_seconds": 10,
  • "liveness_probe.timeout_seconds": 5,
  • "liveness_probe.success_threshold": 1,
  • "liveness_probe.failure_threshold": 3,
  • "hpa.cpu.average_utilization_percent": 60
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
deployment.delay_start_time_sec
integer
Deprecated
Default: 30

please use readiness_probe.initial_delay_seconds and liveness_probe.initial_delay_seconds instead

deployment.custom_domain_check_enabled
boolean
Default: true

disable custom domain check when deploying an application

build.timeout_max_sec
integer
Default: 1800
network.ingress.proxy_body_size_mb
integer
Default: 100
network.ingress.enable_cors
boolean
Default: false
network.ingress.cors_allow_origin
string
Default: "*"
network.ingress.cors_allow_methods
string
Default: "GET, PUT, POST, DELETE, PATCH, OPTIONS"
network.ingress.cors_allow_headers
string
Default: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization"
network.ingress.proxy_buffer_size_kb
integer
Default: 4

header buffer size used while reading response header from upstream

network.ingress.keepalive_time_seconds
integer
Default: 3600

Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection

network.ingress.keepalive_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open.

network.ingress.send_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for transmitting a response to the client

network.ingress.proxy_connect_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for establishing a connection to a proxied server

network.ingress.proxy_send_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for transmitting a request to the proxied server

network.ingress.proxy_read_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for reading a response from the proxied server

network.ingress.whitelist_source_range
string
Default: "0.0.0.0/0"

list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0.

readiness_probe.type
string
Default: "TCP"
Enum: "NONE" "TCP" "HTTP"

NONE disable readiness probe TCP enable TCP readiness probe HTTP enable HTTP readiness probe

readiness_probe.http_get.path
string
Default: "/"

HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP

readiness_probe.initial_delay_seconds
integer
Default: 30

Delay before liveness probe is initiated

readiness_probe.period_seconds
integer
Default: 10

How often to perform the probe

readiness_probe.timeout_seconds
integer
Default: 1

When the probe times out

readiness_probe.success_threshold
integer
Default: 1

Minimum consecutive successes for the probe to be considered successful after having failed.

readiness_probe.failure_threshold
integer
Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

liveness_probe.type
string
Default: "TCP"
Enum: "NONE" "TCP" "HTTP"

NONE disable liveness probe TCP enable TCP liveness probe HTTP enable HTTP liveness probe

liveness_probe.http_get.path
string
Default: "/"

HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP

liveness_probe.initial_delay_seconds
integer
Default: 30

Delay before liveness probe is initiated

liveness_probe.period_seconds
integer
Default: 10

How often to perform the probe

liveness_probe.timeout_seconds
integer
Default: 5

When the probe times out

liveness_probe.success_threshold
integer
Default: 1

Minimum consecutive successes for the probe to be considered successful after having failed.

liveness_probe.failure_threshold
integer
Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

hpa.cpu.average_utilization_percent
integer
Default: 60

Percentage value of cpu usage at which point pods should scale up.

Responses

Request samples

Content type
application/json
{
  • "deployment.delay_start_time_sec": 30,
  • "deployment.custom_domain_check_enabled": true,
  • "build.timeout_max_sec": 1800,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "readiness_probe.type": "NONE",
  • "readiness_probe.http_get.path": "/",
  • "readiness_probe.initial_delay_seconds": 30,
  • "readiness_probe.period_seconds": 10,
  • "readiness_probe.timeout_seconds": 1,
  • "readiness_probe.success_threshold": 1,
  • "readiness_probe.failure_threshold": 3,
  • "liveness_probe.type": "NONE",
  • "liveness_probe.http_get.path": "/",
  • "liveness_probe.initial_delay_seconds": 30,
  • "liveness_probe.period_seconds": 10,
  • "liveness_probe.timeout_seconds": 5,
  • "liveness_probe.success_threshold": 1,
  • "liveness_probe.failure_threshold": 3,
  • "hpa.cpu.average_utilization_percent": 60
}

Response samples

Content type
application/json
{
  • "deployment.delay_start_time_sec": 30,
  • "deployment.custom_domain_check_enabled": true,
  • "build.timeout_max_sec": 1800,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "readiness_probe.type": "NONE",
  • "readiness_probe.http_get.path": "/",
  • "readiness_probe.initial_delay_seconds": 30,
  • "readiness_probe.period_seconds": 10,
  • "readiness_probe.timeout_seconds": 1,
  • "readiness_probe.success_threshold": 1,
  • "readiness_probe.failure_threshold": 3,
  • "liveness_probe.type": "NONE",
  • "liveness_probe.http_get.path": "/",
  • "liveness_probe.initial_delay_seconds": 30,
  • "liveness_probe.period_seconds": 10,
  • "liveness_probe.timeout_seconds": 5,
  • "liveness_probe.success_threshold": 1,
  • "liveness_probe.failure_threshold": 3,
  • "hpa.cpu.average_utilization_percent": 60
}

Custom Domain

List application custom domains

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the application.

Add a custom domain to this application in order not to use qovery autogenerated domain

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

customDomainId
required
string <uuid>

Custom Domain ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Get Custom Domain status

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Dependency

List application dependencies

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add application dependency to this application.

Add application dependency to this application to prevent this application starting before the linked dependencies

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetApplicationId
required
string <uuid>

Target application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "BUILDPACKS",
  • "dockerfile_path": "string",
  • "buildpack_language": "CLOJURE",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthcheck": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Remove application dependency to this application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetApplicationId
required
string <uuid>

Target application ID

Responses

Application Metrics

List currently running instances of the application with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the application

Returns min, max, and running number of instances of the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get CPU consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the application

The value returned corresponds to the 95th centile

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List application restarts

Get application restart message and timestamp.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Database

List linked databases

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Link a database to the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetDatabaseId
required
string <uuid>

Target database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Remove database link to this application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetDatabaseId
required
string <uuid>

Target database ID

Responses

List linked logical databases

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Link a logical database to the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetLogicalDatabaseId
required
string <uuid>

Target database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "database": {
    }
}

Remove logical database link to this application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

targetLogicalDatabaseId
required
string <uuid>

Target database ID

Responses

Application Logs

List logs

This will list the last 1000 logs of the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Deployment Restriction

Get application deployment restrictions

Get application deployment restrictions

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "deployment_restrictions": [
    ]
}

Create an application deployment restriction

Create an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
mode
required
string (DeploymentRestrictionModeEnum)
Enum: "EXCLUDE" "MATCH"

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

type
required
string (DeploymentRestrictionTypeEnum)
Value: "PATH"
value
required
string

For PATH restrictions, the value must not start with /

Responses

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Edit an application deployment restriction

Edit an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

deploymentRestrictionId
required
string <uuid>

Deployment Restriction ID

Request Body schema: application/json
mode
required
string (DeploymentRestrictionModeEnum)
Enum: "EXCLUDE" "MATCH"

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

type
required
string (DeploymentRestrictionTypeEnum)
Value: "PATH"
value
required
string

For PATH restrictions, the value must not start with /

Responses

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Delete an application deployment restriction

Delete an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

deploymentRestrictionId
required
string <uuid>

Deployment Restriction ID

Responses

Application Deployment History

List application deploys

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter. You can also filter by status (FAILED or SUCCESS), and git_commit_id

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Application Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the application

  • Add an environment variable to the application.
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from an application

  • To delete an environment variable from an application you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Responses

Edit an environment variable belonging to the application

  • You can't edit a BUILT_IN variable
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable override at the application level

  • Allows you to override at application level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at application level with the same key as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the overridden_variable will be exposed in the "overridden_variable" field of the newly created variable
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable alias at the application level

  • Allows you to add an alias at application level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at application level with the same value as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Application Secret

List application secrets

Secrets are like environment variables, but they are secured and can't be revealed.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the application

  • Add a secret to the application.
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the secret. Clear value will never be returned

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete a secret from an application

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

secretId
required
string <uuid>

Secret ID

Responses

Edit a secret belonging to the application

  • You can't edit a BUILT_IN secret
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string
key
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret override at the application level

  • Allows you to override at application level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at application level with the same key as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the overridden_secret will be exposed in the "overridden_secret" field of the newly created secret
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret alias at the application level

  • Allows you to add an alias at application level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at application level with the same value as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Application Event

List application events

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Main Calls

Get container by ID

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true,
  • "ports": [
    ]
}

Edit container

  • To edit the container you must have the admin permission.
  • For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it.
  • For storage edition, if you provide a storage id, we will update the corresponding storage. If you don't we will create a new one. If you remove a storage from the payload, we will delete it.
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

registry_id
required
string

id of the linked registry

image_name
required
string

The image name pattern differs according to chosen container registry provider:

  • ECR: repository
  • SCALEWAY_CR: namespace/image
  • DOCKER_HUB: image or repository/image
  • PUBLIC_ECR: registry_alias/repository
tag
required
string

tag of the image container

arguments
Array of strings
entrypoint
string

optional entrypoint when launching container

cpu
integer
Default: 500

unit is millicores (m). 1000m = 1 cpu

memory
integer
Default: 512

unit is MB. 1024 MB = 1GB

min_running_instances
integer >= 0
Default: 1

Minimum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: 0 means that there is no container running.

max_running_instances
integer
Default: 1

Maximum number of instances running. This resource auto-scale based on the CPU and Memory consumption. Note: -1 means that there is no limit.

auto_preview
boolean

Indicates if the 'environment preview option' is enabled for this container.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

Responses

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "registry_id": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true,
  • "ports": [
    ]
}

Delete container

To delete the container you must have the admin permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Get container status

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Container Actions

Deploy container

You must provide a git commit id

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
image_tag
required
string

Image tag to deploy

Responses

Request samples

Content type
application/json
{
  • "image_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Stop container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Restart container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Container Configuration

Get advanced settings

Get list and values of the advanced settings of the container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
Array
deployment.custom_domain_check_enabled
boolean
Default: true

disable custom domain check when deploying an application

network.ingress.proxy_body_size_mb
integer
Default: 100
network.ingress.enable_cors
boolean
Default: false
network.ingress.cors_allow_origin
string
Default: "*"
network.ingress.cors_allow_methods
string
Default: "GET, PUT, POST, DELETE, PATCH, OPTIONS"
network.ingress.cors_allow_headers
string
Default: "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization"
network.ingress.proxy_buffer_size_kb
integer
Default: 4

header buffer size used while reading response header from upstream

network.ingress.keepalive_time_seconds
integer
Default: 3600

Limits the maximum time (in seconds) during which requests can be processed through one keepalive connection

network.ingress.keepalive_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) during which an idle keepalive connection to an upstream server will stay open.

network.ingress.send_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for transmitting a response to the client

network.ingress.proxy_connect_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for establishing a connection to a proxied server

network.ingress.proxy_send_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for transmitting a request to the proxied server

network.ingress.proxy_read_timeout_seconds
integer
Default: 60

Sets a timeout (in seconds) for reading a response from the proxied server

network.ingress.whitelist_source_range
string
Default: "0.0.0.0/0"

list of source ranges to allow access to ingress proxy. This property can be used to whitelist source IP ranges for ingress proxy. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1 To allow all source ranges, set 0.0.0.0/0.

readiness_probe.type
string
Default: "TCP"
Enum: "NONE" "TCP" "HTTP"

NONE disable readiness probe TCP enable TCP readiness probe HTTP enable HTTP readiness probe

readiness_probe.http_get.path
string
Default: "/"

HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP

readiness_probe.initial_delay_seconds
integer
Default: 30

Delay before liveness probe is initiated

readiness_probe.period_seconds
integer
Default: 10

How often to perform the probe

readiness_probe.timeout_seconds
integer
Default: 1

When the probe times out

readiness_probe.success_threshold
integer
Default: 1

Minimum consecutive successes for the probe to be considered successful after having failed.

readiness_probe.failure_threshold
integer
Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

liveness_probe.type
string
Default: "TCP"
Enum: "NONE" "TCP" "HTTP"

NONE disable liveness probe TCP enable TCP liveness probe HTTP enable HTTP liveness probe

liveness_probe.http_get.path
string
Default: "/"

HTTP GET path to check status (must returns 2xx E.g "/healtz") - only usable with TYPE = HTTP

liveness_probe.initial_delay_seconds
integer
Default: 30

Delay before liveness probe is initiated

liveness_probe.period_seconds
integer
Default: 10

How often to perform the probe

liveness_probe.timeout_seconds
integer
Default: 5

When the probe times out

liveness_probe.success_threshold
integer
Default: 1

Minimum consecutive successes for the probe to be considered successful after having failed.

liveness_probe.failure_threshold
integer
Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get Container Network information

Get status of the container network settings.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Container Network

Edit the Network settings of the container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
sticky_session
boolean
Default: false

Specify if the sticky session option (also called persistant session) is activated or not for this container. If activated, user will be redirected by the load balancer to the same instance each time he access to the container.

Responses

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Container Custom Domain

List container custom domains

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the container.

Add a custom domain to this container in order not to use qovery autogenerated domain

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

customDomainId
required
string <uuid>

Custom Domain ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Get Custom Domain status

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Container Dependency

List container dependencies

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add container dependency to this application.

Add container dependency to this container to prevent this container starting before the linked dependencies

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

targetContainerId
required
string <uuid>

Target container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "auto_preview": true,
  • "ports": [
    ]
}

Remove container dependency to this container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

targetContainerId
required
string <uuid>

Target container ID

Responses

Container Metrics

List currently running instances of the container with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the container

Returns min, max, and running number of instances of the application

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Container Database

List linked logical databases

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Link a logical database to the container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

targetLogicalDatabaseId
required
string <uuid>

Target database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "database": {
    }
}

Remove logical database link to this container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

targetLogicalDatabaseId
required
string <uuid>

Target database ID

Responses

Container Logs

List logs

This will list the last 1000 logs of the container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Container Deployment Restriction

Container Deployment History

List container deployments

Returns the 20 last container deployments

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the container

  • Add an environment variable to the container.
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from a container

  • To delete an environment variable from an container you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Responses

Edit an environment variable belonging to the container

  • You can't edit a BUILT_IN variable
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER)
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the env variable.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable override at the container level

  • Allows you to override at container level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at container level with the same key as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the overridden_variable will be exposed in the "overridden_variable" field of the newly created variable
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create an environment variable alias at the container level

  • Allows you to add an alias at container level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at container level with the same value as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

environmentVariableId
required
string <uuid>

Environment Variable ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Container Secret

List container secrets

Secrets are like environment variables, but they are secured and can't be revealed.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the container

  • Add a secret to the container.
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
key
required
string

key is case sensitive

value
required
string

value of the secret. Clear value will never be returned

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Delete a secret from an container

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

secretId
required
string <uuid>

Secret ID

Responses

Edit a secret belonging to the container

  • You can't edit a BUILT_IN secret
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
  • An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER)
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string
key
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret override at the container level

  • Allows you to override at container level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at container level with the same key as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the overridden_secret will be exposed in the "overridden_secret" field of the newly created secret
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
value
required
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Create a secret alias at the container level

  • Allows you to add an alias at container level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at container level with the same value as the one corresponding to the secret id in the path
  • The response body will contain the newly created secret
  • Information regarding the aliased_secret will be exposed in the "aliased_secret" field of the newly created secret
  • Only 1 alias level is allowed. You can't create an alias on an alias
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

secretId
required
string <uuid>

Secret ID

Request Body schema: application/json
key
required
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION"
}

Container Event

Database Main Calls

Get database by ID

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Edit a database

To edit a database you must have the admin permission

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
name
string

name is case-insensitive

version
string
accessibility
string (DatabaseAccessibilityEnum)
Default: "PRIVATE"
Enum: "PRIVATE" "PUBLIC"
cpu
integer
Default: 250

unit is millicores (m). 1000m = 1 cpu

memory
integer

unit is MB. 1024 MB = 1GB
Default value is linked to the database type:

  • MANAGED: 100
  • CONTAINER
    • POSTGRES: 100
    • REDIS: 100
    • MYSQL: 512
    • MONGODB: 256
storage
integer

unit is GB

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": "10.1",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 4
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Delete a database

To delete a database you must have the admin permission

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Get database status

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

List eligible versions for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get master credentials of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Edit database master credentials

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
login
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Database Actions

Retart database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Stop database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Deploy database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "message": "string",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z"
}

Database Metrics

Get current metric consumption of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "cpu": {
    },
  • "memory": {
    },
  • "storage": {
    }
}

Get CPU consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the database

The value returned corresponds to the 95th centile

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List database restarts

Get database restart message and timestamp.

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Database Deployment History

List database deploys

By default it returns the 20 last results. The response is paginated.

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Logical Database

List logical databases of a database

A logical database exists inside a database. The database is a service that exists within an environment, that you can deploy, and that has allocated resources. A database can have several logical databases

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a logical database on the database

If you don't specify credentials, Qovery will autogenerate them.

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "database": {
    }
}

Get logical database by ID

A logical database exists inside a database. The database is a service that exists within an environment, that you can deploy, and that has allocated resources. A database can have several logical databases

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "database": {
    }
}

Edit a logical database

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "database": {
    }
}

Delete a Logical database

To delete a logical database you must have the project user permission

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Responses

Get credentials of the logical database

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Responses

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Edit logical database credentials

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Request Body schema: application/json
login
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

List linked applications

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List linked containers

Authorizations:
bearerAuth
path Parameters
logicalDatabaseId
required
string <uuid>

Logical Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Database Application

List applications using the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Remove an application from this database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

targetApplicationId
required
string <uuid>

Target application ID

Responses

Database Container

Backups

List database backups

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Add a backup to the Database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
name
required
string
message
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "message": "string",
  • "status": {
    }
}

Remove database backup

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

backupId
required
string <uuid>

Database Backup ID

Responses

Database Event

List database events

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Account Info

Get Account information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nickname": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "profile_picture_url": "string"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Referral & Rewards

Get your referral information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Claim a reward

A same code can be claimed only 3 times at max

Authorizations:
bearerAuth
Request Body schema: application/json
type
string
Value: "INVITATION"
code
string

Responses

Request samples

Content type
application/json
{
  • "type": "INVITATION",
  • "code": "xDowkWEl"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

User Sign Up

Get Sign up information

Retrieve the Sign Up information of the user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}

Send Sign Up request

Send a Sign Up request containing the user information

Authorizations:
bearerAuth
Request Body schema: application/json
first_name
required
string
last_name
required
string
user_email
required
string
type_of_use
required
string (TypeOfUseEnum)
Enum: "PERSONAL" "SCHOOL" "WORK"
qovery_usage
required
string
company_name
string or null
company_size
string (CompanySizeEnum)
Enum: "1-10" "11-50" "51-200" "201-500" "500+"
user_role
string or null
qovery_usage_other
string or null
user_questions
string or null
current_step
string or null
dx_auth
boolean or null

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}